This document provides installation instructions for using ODF with Metrowerks CodeWarrior.
Table of Contents
-------------------------
• Step 1 - Installing CodeWarrior Additions
• Step 2 - Copying ODFDev
• Step 3 - Making an alias to the ODF Library (and sample parts)
• Step 4 - Rebuilding ODF
• Step 5 - Compiling IDL files
Step 1 - Installing CodeWarrior Additions
This CodeWarrior Additions folder contains:
- Headers and libraries for Cyberdog 1.1
- Headers and libraries for OpenDoc 1.1.2
- ODFRC and SOMobjects™ TS plugin compilers
Move the content of these folders into the appropriate folders inside the 'MacOS Support' and 'CodeWarrior Plugins' folders.
Cyberdog headers and libraries are now required to build some ODF components, such as the Internet layer or the ODFBitmap sample part. (Cyberdog is not required to run the ODFBitmap sample part.)
Step 2 - Copying ODFDev
Copy the ODFDev folder in its entirety to your local hard drive. This folder contains the ODF source code and the source code for ODF's example parts. The 'ODFDev:ODF:' subfolder contains configurations and project setups for building the ODF libraries.
The ODF folder and the folders for each sample part contain multiple subfolders folders that specify the build configurations for each development environment. Inside these folders are project files and build scripts required for building ODF (or the sample part) with the specified development environment. Once you have copied the ODFDev folder to your local hard drive, you can throw away the folders for any development environments you are not using.
The following table lists the folder name, the supported compiler, and the resulting configuration for the ODF library or part editor.
Folder Compiler Resulting ODF Libraries Resulting Sample Part
The following table indicates which folders are necessary for each supported compiler.
Folder CW/PPC CW/68K Symantec68K MrC
CWPPCDebug Yes No No No
CWPPCRelease Yes No No No
MCPPCDebug No No No Yes
MCPPCRelease No No No Yes
CW68KDebug No Yes No No
CW68kRelease No Yes No No
SC68KDebug No No Yes No
SC68KRelease No No Yes No
SL68KDebug No Yes Yes No
SL68KRelease No Yes Yes No
SLPPCDebug Yes No No Yes
SLPPCRelease Yes No No Yes
Step 3 - Making an alias to the ODF library (and sample parts).
To make debugging with ODF easier, you should make an alias to the debug version of the ODF shared library and put that alias into your Editors folder. Debuggers use this alias during debugging sessions to trace your code's execution into the ODF shared library.
If your ODFDev folder is on a different volume than your system folder, you can create an Editors folder at the root level of your development hard drive and put the alias there. (OpenDoc does not allow you to put aliases to files on different volumes in the Editors folder.)
Note: The ODFLibrary (or an alias to it) must be located in your Editors folder. Part editors that were built with ODF require the existence of this library and will not run without it.
The debug version of the ODF shared library (ODFLibrary) is already built and is located in the 'ODFDev:ODF:SLPPCDebug:Bin:' folder for PPC and in the 'ODFDev:ODF:SL68KDebug:Bin:' for 68K.
For convenience, you can also make an alias to the symbol files for the ODFLibrary (ODFLibrary.xSYM) and put it on your desktop. When you want to load the symbol file into the CodeWarrior debugger, you can double-click on the alias.
IMPORTANT: Make sure that the release version of the ODFLibrary or any of the ODF sample parts are not installed on your machine while you are attempting to trace through either the ODFLibrary or sample parts. The chances are good that you will not get the right library. OpenDoc searches for the first part editor and library that matches its search parameters. The release version of the ODF libraries and samples are simply optimized versions that do not have internal debugging information, such as Macsbug symbols or assertions.
Step 4 - Rebuilding ODF
Although ODF is supplied pre-built, debugging will be easier if you rebuild it once to create symbol files that contain the correct path information for your hard drive. If you do not do this, the CodeWarrior debugger will ask you for the location of any ODF files it cannot find during your debug session.
To rebuild ODF, run the ODF Builder (CW) application, located in the ODFDev folder. By default it will rebuild both PPC debug and PPC release versions of ODF and all the examples. You can also use the ODF Builder application to rebuild the 68K projects or prevent the building of the examples.
The ODF Builder can rebuild both PPC and 68K version of the ODF Shared Library. However, you must remember that you are rebuilding the ODFLibrary only for debugging convenience (to prevent the Metrowerks debugger from asking you where ODF files are located). When you ship your part, you must include the release version of the ODFLibrary included in this distribution, and not the one you rebuilt.
You can use the MPW script CWBuildAllSOM to rebuild all ODF '.xh' and '.xih' files. Because ODF already provides those files it is not necessary for you to use this script at all. It is just provided as a convinience in case it is needed.
Step 5 - Compiling IDL files
IMPORTANT: this step is optional unless you are writing an OpenDoc extension or are going to use SOM directly. Building an ODF part doesn't require any SOM compilation. If you are not sure then you can safely skip this step.
To compile IDL files, you must use the SOM compiler. The SOM compiler currently runs only as an MPW or ToolServer tool and is part of the ETO package. When using CodeWarrior you should install ToolServer which is also available from CodeWarrior Gold Reference.
Please see the document "Compiling IDL Files" located in the "Documentation:Development Notes:" folder and the CodeWarrior Build Guide for information about IDL files and setting up the SOM compiler.
